

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">

<html>
<head>
<script type="text/javascript" src="helpman_topicinit.js"></script>

<title>EA_OnRetrieveModelTemplate [Enterprise Architect User Guide]</title>

<meta name="keywords" content="Enterprise Architect, Sparx Systems, UML, EA_OnRetrieveModelTemplate,EA_OnRetrieveModelTemplate Broadcast Events, Add-In Model,Add-In Model,Add-In Model EA_OnRetrieveModelTemplate,Add-In Model Broadcast Event, EA_OnRetrieveModelTemplate,Broadcast Event,Broadcast Event EA_OnRetrieveModelTemplate">
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
<meta http-equiv="Content-Style-Type" content="text/css" />

<link type="text/css" href="default.css" rel="stylesheet" />
<style type="text/css">
  A, A:Visited
  {
    color: #00F;
  }

  A:Active, A:Hover
  {
    color: #F00;
  }

  OL
  {
    margin: 5px 0 5px 48px;
  }

  UL
  {
    margin-bottom: 3px;
    margin-top: 0;
  }

  #nsr
  {
    background-color: #D4DFFF;
  }

  #nsr A
  {
    text-decoration: none;
  }

  #mainbody
  {
    padding: 8px;
  }

  .p_BodyText
  {
    padding: 5px 0;
  }
</style>



<style type="text/css" media="screen">
  BODY
  {
    background-color: #FFFFFF;
  }

  #nsr
  {
    padding: 6px 6px 0 6px;
    border-bottom: none;
    vertical-align: top;
    z-index: 2;
    visibility: visible;
    left: 0;
    top: 0;
    position: absolute;
  }

  #mainbody
  {
    left: 0;
    top: 0;
    margin: 0;
    position: absolute;
    padding: 10px;
    overflow: auto;
    height: 100%;
    z-index: 1;
    background-repeat: no-repeat;
    background-position: bottom right;
    background-attachment: fixed;
  }
</style>

<style type="text/css" media="print">
  #nsr
  {
    visibility: none;
  }

  #mainbody
  {
    overflow: visible;
  }
</style>
<script type="text/javascript" language="JavaScript" src="nonscroll.js"></script>

</head>
<body scroll="no">

<div id="page">



        <div id="content">
          <div id="content-inner">
          



  
          <div id="nsr">
            <table border="0" cellspacing="0" cellpadding="4" width="100%">
              <tr valign="top">
                <td align="left">
  


                  <p class="p_Heading1"><span class="f_Heading1">EA_OnRetrieveModelTemplate</span></p>



  
                </td>
                <td align="right">
                  <a href="introduction.htm" onmouseover="document.images.main.src='button_main_h.gif'" onmouseout="document.images.main.src='button_main.gif'">
                    <img name="main" src="button_main.gif" border=0 alt="Return to Introduction">
                  </a>&nbsp;
    
                  <a href="model_validation_example.htm" onmouseover="document.images.prev.src='button_prev_h.gif'" onmouseout="document.images.prev.src='button_prev.gif'">
                    <img name=prev src="button_prev.gif" border=0 alt="Previous page" />
                  </a>&nbsp;
    
    
    
                  <a href="ea_oninitialize_technologies.htm" onmouseover="document.images.next.src='button_next_h.gif'" onmouseout="document.images.next.src='button_next.gif'">
                    <img name=next src="button_next.gif" border=0 alt="Next page" />
                  </a>
    
    
                </td>
              </tr>
            </table>
          </div>
          <div id="mainbody">
  


                <p class="p_SubHeadingL1"><span class="f_SubHeadingL1">Details</span></p>
<p class="p_BodyText"><span class="f_BodyText" style="font-style: italic;">EA_OnRetrieveModelTemplate</span><span class="f_BodyText"> requests that an Add-In pass a model template to Enterprise Architect.</span></p>
<p class="p_BodyText"><span class="f_BodyText">This event occurs when a user executes the </span><span class="f_MenuKeyField">Add a New Model Using Wizard</span><span class="f_BodyText"> command to add a model that has been defined by an MDG Technology. See </span><span class="f_BodyText">the </span><span class="f_BodyText" style="font-style: italic;"><a href="model_templates2.htm">Incorporate Model Templates in a Technology</a></span><span class="f_BodyText"> topic</span><span class="f_BodyText"> for details of how to define such model templates.</span></p>
<p class="p_SubHeadingL1"><span class="f_SubHeadingL1">Syntax</span></p>
<p class="p_BodyText"><span class="f_BodyText" style="font-style: italic; font-weight: bold;">Function </span><span class="f_BodyText" style="font-weight: bold;">EA_OnRetrieveModelTemplate</span><span class="f_BodyText" style="font-style: italic; font-weight: bold;">(Repository As EA.Repository,sLocation As String) As String</span></p>
<p class="p_BodyText"><span class="f_BodyText">The </span><span class="f_BodyText" style="font-style: italic;">EA_OnRetrieveModelTemplate</span><span class="f_BodyText"> function syntax contains the following elements:</span></p>
<div style="text-align: left; text-indent: 0px; padding: 0px 0px 0px 0px; margin: 5px 0px 5px 13px;"><table cellspacing="0" cellpadding="0" border="0" style="border: none; border-spacing:0px; border-collapse: collapse;">
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="87" bgcolor="#e3e6ed" style="width:87px; background-color:#e3e6ed; border: solid 1px #000000;"><p class="p_Tableheader"><span class="f_Tableheader">Parameter</span></p>
</td>
<td valign="top" width="97" bgcolor="#e3e6ed" style="width:97px; background-color:#e3e6ed; border: solid 1px #000000;"><p class="p_Tableheader"><span class="f_Tableheader">Type</span></p>
</td>
<td valign="top" width="70" bgcolor="#e3e6ed" style="width:70px; background-color:#e3e6ed; border: solid 1px #000000;"><p class="p_Tableheader"><span class="f_Tableheader">Direction</span></p>
</td>
<td valign="top" width="453" bgcolor="#e3e6ed" style="width:453px; background-color:#e3e6ed; border: solid 1px #000000;"><p class="p_Tableheader"><span class="f_Tableheader">Description</span></p>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="87" style="width:87px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-weight: bold;">Repository</span></p>
</td>
<td valign="top" width="97" style="width:97px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-style: italic;"><a href="repository3.htm">EA.Repository</a></span></p>
</td>
<td valign="top" width="70" style="width:70px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">IN</span></p>
</td>
<td valign="top" width="453" style="width:453px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">An </span><span class="f_Tabletext" style="font-style: italic;">EA.Repository</span><span class="f_Tabletext"> object representing the currently open Enterprise Architect model. Poll its members to retrieve model data and user interface status information.</span></p>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="87" style="width:87px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-weight: bold;">sLocation</span></p>
</td>
<td valign="top" width="97" style="width:97px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-style: italic;">String</span></p>
</td>
<td valign="top" width="70" style="width:70px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">IN</span></p>
</td>
<td valign="top" width="453" style="width:453px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">The name of the template requested. This should match the </span><span class="f_Tabletext" style="font-style: italic;">location</span><span class="f_Tabletext"> attribute in the &lt;</span><span class="f_Tabletext" style="font-style: italic;">ModelTemplates</span><span class="f_Tabletext">&gt; section of an MDG Technology File. For more information, see the </span><span class="f_Tabletext" style="font-style: italic;">Incorporate Model Templates in a Technology</span><span class="f_Tabletext"> topic.</span></p>
</td>
</tr>
</table>
</div>
<p class="p_SubHeadingL1"><span class="f_SubHeadingL1">Return Value</span></p>
<p class="p_BodyText"><span class="f_BodyText">Return a string containing the XMI export of the model that is being used as a template.</span></p>
<p class="p_SubHeadingL1"><span class="f_SubHeadingL1">Example</span></p>
<p class="p_Code"><span class="f_Code">&nbsp;</span></p>
<p class="p_Code"><span class="f_Code">Public Function EA_OnRetrieveModelTemplate(ByRef Rep As EA.Repository, ByRef sLocation As String) As String</span></p>
<p class="p_Code"> &nbsp; &nbsp; &nbsp; &nbsp;<span class="f_Code">Dim sTemplate As String</span></p>
<p class="p_Code"> &nbsp; &nbsp; &nbsp; &nbsp;<span class="f_Code">Select Case sLocation</span></p>
<p class="p_Code"> &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;<span class="f_Code">Case &quot;Templates\Template1.xml&quot;</span></p>
<p class="p_Code"> &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;<span class="f_Code">sTemplate = My.Resources.Template1</span></p>
<p class="p_Code"> &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;<span class="f_Code">Case &quot;Templates\Template2.xml&quot;</span></p>
<p class="p_Code"> &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;<span class="f_Code">sTemplate = My.Resources.Template2</span></p>
<p class="p_Code"> &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;<span class="f_Code">Case &quot;Templates\Template3.xml&quot;</span></p>
<p class="p_Code"> &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;<span class="f_Code">sTemplate = My.Resources.Template3</span></p>
<p class="p_Code"> &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;<span class="f_Code">Case Else</span></p>
<p class="p_Code"> &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;<span class="f_Code">MsgBox(&quot;Path for &quot; &amp; sLocation &amp; &quot; not found&quot;)</span></p>
<p class="p_Code"> &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;<span class="f_Code">sTemplate = &quot;&quot;</span></p>
<p class="p_Code"> &nbsp; &nbsp; &nbsp; &nbsp;<span class="f_Code">End Select</span></p>
<p class="p_Code"> &nbsp; &nbsp; &nbsp; &nbsp;<span class="f_Code">EA_OnRetrieveModelTemplate = sTemplate</span></p>
<p class="p_Code"><span class="f_Code">End Function</span></p>




            </div>
          </div>
        </div>



</div>


</body>
</html>
